Skip to content

docs: trim README to point at tabmesh.dev for the depth#22

Merged
joelshejar merged 1 commit into
mainfrom
docs/trim-readme
May 11, 2026
Merged

docs: trim README to point at tabmesh.dev for the depth#22
joelshejar merged 1 commit into
mainfrom
docs/trim-readme

Conversation

@joelshejar
Copy link
Copy Markdown
Member

Summary

Step 4 of the docs-site work. Trims the README from 198 lines to 67. The depth content lives at `tabmesh.dev` per ADR-0004 and the migration completed in #21.

Kept in README

  • One-paragraph "what it solves" framing
  • 10-line quickstart code block
  • Status badges (license, pre-1.0, docs)
  • Direct links to the docs sections (quickstart, gotchas, architecture, playground, roadmap)
  • Pre-1.0 status notice
  • Development commands

Moved out

  • Architecture diagram → `/guide/architecture`
  • Full gotchas list → `/guide/gotchas`
  • Configuration table → `/reference/config`
  • System events list → `/reference/system-events`
  • React snippet → `/guide/react`

Test plan

  • `pnpm exec biome check .` clean
  • All linked URLs resolve to existing pages in the docs site
  • GitHub markdown preview renders cleanly

The README is now the "decide if you care" surface. Depth content
moved to https://tabmesh.dev in PR #21.

Kept in README:
- One-paragraph framing of what TabMesh solves
- Minimal install + 10-line quickstart code block
- Status badges (license, pre-1.0, docs)
- Links to the docs site (quickstart, gotchas, architecture,
  playground, roadmap)
- Pre-1.0 status notice
- Development commands

Moved out (now lives at tabmesh.dev):
- Architecture diagram → /guide/architecture
- Full gotchas list → /guide/gotchas
- Configuration table → /reference/config
- System events list → /reference/system-events
- React snippet → /guide/react

67 lines, down from 198. Both surfaces have their own audience:
the README is for GitHub/npm browse, the docs site is for serious
adopters.
@joelshejar joelshejar merged commit 442ff6f into main May 11, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant